[6.0] Extend versioning, save releated information in history table and restore historical data by rdeutz · Pull Request #45515 · joomla/joomla-cms

rdeutz · 2025-05-22T08:22:57Z

Our versioning works on databse table level, this leads to situations that we save an article with custom fields but the CF are not included in the history. This is unexpected from a user perspective. This PR starts to change this behaviour so that releated information are also saved.

Summary of Changes

I have added an interface VersionableModelInterface, if a model implements this interface then in AdminModel the save of the histroy data is done in the save method (calls saveHistory) of the Model. This is the first step and we have now the data with releated information in the history table.

If you want to restore a version then in loadHistory (VersionableModelTrait) set the data from the history table as session data and loadForm use this data when you edit an item.

It works for CF so far. At the moment not for Tags (tags is a pain, we might change more on tags for 6 so I haven't looked into the details why not).

This is a b/c break and I don't know how many are affected but I think that it can't be too much hassle and what we get when we finish this is worth the work for extensions developers.

Look into tags
Extend to other core items where we are using versions (Banner, Banner Client, newfeeds, Categories Tags).
Remove behaviour plugin
Fix tests

Testing Instructions

It is now done for all core extensions and item whitch supports versions

Create some custom fields
Create an article and save some versions of it
Restore versions back and force

Actual result BEFORE applying this Pull Request

Custom fields have always the last saved value

Expected result AFTER applying this Pull Request

Custom fields have the value from the saved version, Tags get restored

Link to documentations

Documentation will be provided at a later stage.

Please select:

Documentation link for docs.joomla.org:
No documentation changes for docs.joomla.org needed
Pull Request link for manual.joomla.org:
No documentation changes for manual.joomla.org needed

libraries/src/MVC/Model/VersionableModelInterface.php

libraries/src/Versioning/VersionableModelTrait.php

Co-authored-by: Brian Teeman <brian@teeman.net>

plugins/behaviour/versionable/src/Extension/Versionable.php

peterpeter · 2025-05-31T20:40:08Z

I have tested this item ✅ successfully on eb8533b

Successful tested with a text-, integer-, list- and checkboxfield(s).

B.t.w.
Comparing versions is throwing an error:
https://prnt.sc/bvWwN0TaKwSq
with or without this patch

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45515.}

peterpeter · 2025-05-31T20:41:29Z

I have tested this item ✅ successfully on eb8533b

Successful tested with a text-, integer-, list- and checkboxfield(s).

B.t.w.
Comparing versions is throwing an error:
https://prnt.sc/bvWwN0TaKwSq
with or without this patch

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45515.}

rdeutz · 2025-08-04T18:29:50Z

I now know why the tests are failing, when creating a banner over the api only the table class is used and not the model. So the problem is "only" an API problem.

softforge · 2025-08-08T15:19:21Z

I also got the An error has occurred. 0 htmlspecialchars(): Argument #1 ($string) must be of type string, array given error when comparing with or without, but the PR certainly restores the custom fields and tags restored, really nice feature

exlemor · 2025-08-09T03:06:07Z

@rdeutz - there are some issues with this PR ;(

Sometimes it restores with a blank article, sometimes not, (no error message), Tags not restored :/

(sorry)

richard67 · 2025-08-11T20:08:49Z

I now know why the tests are failing, when creating a banner over the api only the table class is used and not the model. So the problem is "only" an API problem.

@rdeutz Then the failing API test should be commented out with a to do comment so that system tests are passing. Merging this PR as it is would mean to break system tests in the 6.0-dev branch.

muhme · 2025-08-12T05:57:55Z

I now know why the tests are failing, when creating a banner over the api only the table class is used and not the model. So the problem is "only" an API problem.

Maybe @heelc29 or @alikon could help with the API so that the system test works again?

exlemor · 2025-08-16T13:01:22Z

I have tested this item ✅ successfully on c027b4d

I have re-tested this successfully. Thanks @rdeutz! Keep up the great work!

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45515.}

administrator/components/com_contenthistory/tmpl/compare/compare.php

brianteeman · 2025-08-16T13:27:25Z

When you restore to the initial version the buttons disappear AND you cannot save the article

See video

chrome_0NbUOiTwTM.mp4

brianteeman · 2025-08-16T13:27:59Z

I have tested this item 🔴 unsuccessfully on c027b4d

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45515.}

libraries/src/MVC/Model/AdminModel.php

Co-authored-by: Martina Scholz <64533137+LadySolveig@users.noreply.github.com>

libraries/src/MVC/Model/AdminModel.php

softforge · 2025-08-17T10:38:05Z

Thank you to @rdeutz for his work on this and to @LadySolveig and @richard67 for the work they did fixing this to the point we could merge. Thank you to all the testers and also for the work done by @brianteeman to make sure deficiencies were noted and documented so we have a clear measure of what must be done to get this ready before RC

heelc29 · 2025-08-17T10:39:00Z

I have tested this item 🔴 unsuccessfully on c027b4d

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45515.}

heelc29 · 2025-08-17T10:39:09Z

Still issues

Create new article and save two times (2 versions are stored) - before only 1 version

Star to mark current version is no longer working

Restore options (e.g. show/hide title) from older history not working

richard67 · 2025-08-17T10:47:36Z

@heelc29 Could you open a new issue with your findings? Maybe @brianteeman could then add his findings, too.

rdeutz · 2025-08-17T10:51:20Z

Thank you all for testing and pointing out the issues. I know there are still issues and I will do my best to fix them asap.

ceford · 2025-09-03T14:37:58Z

At the bottom of the Preview of Version form there is a com_fields label that looks like an untranslated string, along with two others above and one below. Is that a bug? And the current version is not marked! The Help screen says it is.

RFC extend versioning

b2ac1ce

joomla-cms-bot added the PR-6.0-dev label May 22, 2025

cs fix

02e48ba

rdeutz added the b/c break This item changes the behavior in an incompatible why. HEADS UP label May 22, 2025

cs fix 2

385e025

brianteeman reviewed May 22, 2025

View reviewed changes

libraries/src/MVC/Model/VersionableModelInterface.php Outdated Show resolved Hide resolved

brianteeman reviewed May 22, 2025

View reviewed changes

libraries/src/Versioning/VersionableModelTrait.php Outdated Show resolved Hide resolved

rdeutz and others added 3 commits May 22, 2025 11:07

Update libraries/src/MVC/Model/VersionableModelInterface.php

3d832a5

Co-authored-by: Brian Teeman <brian@teeman.net>

Update libraries/src/Versioning/VersionableModelTrait.php

dc5e7a1

Co-authored-by: Brian Teeman <brian@teeman.net>

Merge branch '6.0-dev' into versions

eb8533b

dgrammatiko reviewed May 22, 2025

View reviewed changes

plugins/behaviour/versionable/src/Extension/Versionable.php Outdated Show resolved Hide resolved

rdeutz added the Feature label May 28, 2025

richard67 changed the title ~~[6.0] RFC extend versioning, save releated information in history table and restore historcal data~~ [6.0] RFC extend versioning, save releated information in history table and restore historical data Jun 3, 2025

rdeutz and others added 7 commits June 12, 2025 14:03

Merge branch '6.0-dev' into versions

3eac007

Merge branch '6.0-dev' into versions

59d76b1

Merge remote-tracking branch 'Joomla-main-repo/6.0-dev' into versions

c7734b3

Merge branch '6.0-dev' into versions

47d49b4

same change for other models

372ab96

cs

35e01da

fix json decode for history

8495392

Merge branch '6.0-dev' into versions

028805a

Merge branch '6.0-dev' into versions

4604ba3

fix testing

326f17c

brianteeman reviewed Aug 16, 2025

View reviewed changes

administrator/components/com_contenthistory/tmpl/compare/compare.php Show resolved Hide resolved

brianteeman reviewed Aug 16, 2025

View reviewed changes

administrator/components/com_contenthistory/tmpl/compare/compare.php Show resolved Hide resolved

LadySolveig reviewed Aug 16, 2025

View reviewed changes

libraries/src/MVC/Model/AdminModel.php Show resolved Hide resolved

richard67 and others added 2 commits August 17, 2025 12:04

Apply suggestion from code review

239db54

Co-authored-by: Martina Scholz <64533137+LadySolveig@users.noreply.github.com>

Merge branch '6.0-dev' into versions

8728cd0

richard67 reviewed Aug 17, 2025

View reviewed changes

libraries/src/MVC/Model/AdminModel.php Outdated Show resolved Hide resolved

Fix PHPCS

4a424ce

softforge added this to the Joomla! 6.0.0 milestone Aug 17, 2025

softforge merged commit adb79e9 into joomla:6.0-dev Aug 17, 2025
30 checks passed

rdeutz deleted the versions branch August 17, 2025 11:20

jgerman-bot mentioned this pull request Aug 18, 2025

[6.0] Extend versioning, save releated information in history table and restore historical data joomlagerman/joomla#3569

Closed

joomlapl-bot mentioned this pull request Aug 18, 2025

[6.0] Extend versioning, save releated information in history table and restore historical data JoomlaPolska/jezyk-J4#739

Closed

rdeutz mentioned this pull request Aug 21, 2025

[6.0] Version fixes #45955

Closed

9 tasks

qodo-code-review bot mentioned this pull request Aug 23, 2025

Update new features documentation for version changes joomla/Manual#507

Merged

richard67 mentioned this pull request Aug 31, 2025

[6.0] Upmerges - 2025-08-31 #46016

Merged

HLeithner mentioned this pull request Sep 1, 2025

Update migration notes for backward compatibility removal joomla/Manual#506

Merged

richard67 mentioned this pull request Sep 10, 2025

[6.0] Adds missing use statements to VersionableModelTrait.php. #46063 #46064

Closed

4 tasks

richard67 added a commit to richard67/joomla-cms that referenced this pull request Sep 10, 2025

Revert PR joomla#45515

3f79ab8

richard67 mentioned this pull request Sep 10, 2025

[6.0] [WiP] Revert PR #45515 extended versioning #46065

Closed

4 tasks

rdeutz mentioned this pull request Sep 11, 2025

[6.0] Versions fixes take2 #46073

Merged

9 tasks

ceford mentioned this pull request Sep 11, 2025

[6.0] New Documentation joomla/documentation#56

Closed

Uh oh!

Conversation

rdeutz commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Testing Instructions

Actual result BEFORE applying this Pull Request

Expected result AFTER applying this Pull Request

Link to documentations

Uh oh!

Uh oh!

Uh oh!

Uh oh!

peterpeter commented May 31, 2025

Uh oh!

peterpeter commented May 31, 2025

Uh oh!

rdeutz commented Aug 4, 2025

Uh oh!

softforge commented Aug 8, 2025

Uh oh!

exlemor commented Aug 9, 2025

Uh oh!

richard67 commented Aug 11, 2025

Uh oh!

muhme commented Aug 12, 2025

Uh oh!

exlemor commented Aug 16, 2025

Uh oh!

Uh oh!

Uh oh!

brianteeman commented Aug 16, 2025

Uh oh!

brianteeman commented Aug 16, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

softforge commented Aug 17, 2025

Uh oh!

heelc29 commented Aug 17, 2025

Uh oh!

heelc29 commented Aug 17, 2025

Uh oh!

richard67 commented Aug 17, 2025

Uh oh!

rdeutz commented Aug 17, 2025

Uh oh!

ceford commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

rdeutz commented May 22, 2025 •

edited

Loading

ceford commented Sep 3, 2025 •

edited

Loading